home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / BARNET / COMPILER / GUAVAC / !Guavac / doc / !Help next >
Text File  |  1998-05-30  |  6KB  |  166 lines
  1. !Help file for Risc OS guavac, version 1.0, release 1.2
  2. January 14th 1998
  3.  
  4. This is guavac, the GNU Java source file compiler, ported to Risc OS
  5. by Peter Naulls (pnaulls@usa.net).
  6.  
  7. guavac is an alternative to javac, the JDK Java compiler.  Since guavac
  8. is written in C++, rather than Java like javac, it is much faster.
  9.  
  10.  
  11. Changes since release 1.1a
  12.  
  13.  * Fixed "Numeric overflow" for long values.
  14.  
  15.  * The source filename would appear wrongly in some throwback situations,
  16.    this has been fixed.
  17.  
  18.  * A Frontend is now included.  Thanks to Jon Wright for this.
  19.  
  20.  
  21. Changes since release 1.1
  22.  
  23.  * Added some example Java programs to the archive.
  24.  
  25.  * Fix for Risc OS 3.5 and 3.6 users who do not have the CallASWI module
  26.    loaded.
  27.  
  28.  
  29. Changes since release 1.0
  30.  
  31.  * guavac will now load the library classes (!Guavac.class/zip) regardless
  32.    of whether it is an image file or not, so you are free to have it as
  33.    an archive (filetype &DDC) and open it if you wish.  Note that you
  34.    shouldn't have library files used by Acorn's Java as an image file,
  35.    as this will confuse !Java.
  36.  
  37.  * guavac correctly finds classes in the CSD. It will also load classes
  38.    if they do not have the "/class" extension.
  39.  
  40.  * The word ordering of double-precision floating point numbers under Risc OS
  41.    is slighty different to most other operating systems.  Previously, double
  42.    words were compiled into classes so that the high and low words were
  43.    reversed.  This has been corrected.
  44.  
  45.  * When guavac looks for classes other than those in the library (e.g. those
  46.    in the CSD) it will load them whether or not they have the "/class"
  47.    extension.  Remember that by default, guavac will not add the extension
  48.    when outputting files.  
  49.  
  50.  
  51. Installation:
  52.  
  53.   Copy the contents of the archive to your HD.  Double-click the
  54.   !Guavac icon to enable it to be run.  If !Guavac reports
  55.   "File 'System:Modules.CallASWI' not found" then you will need to obtain
  56.   the CallASWI module from:
  57.  
  58.     http://micros.hensa.ac.uk/micros/arch/riscos/e/e160/callaswi.zip
  59.  
  60.   and place it inside !Boot.Resources.!System.Modules.
  61.  
  62.  
  63. Usage:
  64.  
  65.   You might like to first copy "hw/java" "loop/java" and "Compile"
  66.   to somewhere and then double-click on the Compile Obey file.
  67.  
  68.   To use it, read the documentation in !Guavac.doc; but in general, the
  69.   usage is:
  70.   
  71.     guavac <source filename>
  72.   
  73.   Where the source file is a java source file, with the file name of
  74.   the format:  program.java, program/java or java/program.  For other Risc
  75.   OS specific questions, see the guavac FAQ, in !Guavac.doc.RO-FAQ
  76.   Have a look at the Compile Obey file for an example of running guavac
  77.   in a taskwindow.
  78.  
  79.   This distribution also contains guavad, a bytecode dissasembler.
  80.   Usage is:
  81.  
  82.     guavad <class filename>
  83.  
  84.  
  85. The following additions to command line options for guavac have been made
  86. for Risc OS:
  87.  
  88. Command line flags:
  89.  
  90.   -ext  By default, guavac will not add the "/class" extension to generated
  91.   classfiles, due to the likelihood of it being truncated to 10 characters
  92.   under the Risc OS filecore.  Using this flag means the extension will be
  93.   added.  Note that not adding the extension is not a problem, since the class
  94.   is filetyped to 'Java' (filetype &AE4).
  95.  
  96.   -th   Use throwback.  To use this, the DDEUtils module must be loaded.
  97.   When using this switch, an editor such as StrongED or Zap which supports
  98.   the throwback protocol will generate a list of files and linenumbers on
  99.   which errors occured.
  100.  
  101.  
  102. Library class files:
  103.  
  104.   By default, guavac will use the !Guavac.class/zip file as a library to
  105.   compile against.  However, if the system variable Java$ClassDir is
  106.   set (as it will be by RISCafe and Chockcino) then the library file to
  107.   which this points will be used instead.  The -classfile flag may be
  108.   used to overide either of these.  There is no need to set this variable.
  109.  
  110.  
  111. Source filenames:
  112.  
  113.   Source files may either be called program/java (assuming the filing system
  114.   you are using can handle this many characters in the filename) or
  115.   be of the format java.program, using the convention of C source files
  116.   under Risc OS.
  117.  
  118.  
  119. Memory Usage:
  120.  
  121.   Since guavac is linked with Unixlib, guavac cannot manually increase its
  122.   Wimpslot, so the wimpslot size must be set first, like GCC.  guavac sets
  123.   the guavac_heap system variable, so under Risc OS 3.5 or later, it will
  124.   use dynamic areas for its heap.  In this case, a Wimpslot of around 2.8Mb
  125.   should be fine.  It will also work with Virtualise if necessary.  On older
  126.   machines, the Wimpslot will need to be higher - experiment as necessary.
  127.   The value of guavac_heap is irrelevant; it only needs to exist, and
  128.   is set in the !Boot file. Please note that later releases of guavac may use
  129.   less memory.
  130.  
  131.  
  132.  
  133. To do:
  134.  
  135.   * Improve handling of unusual Risc OS filenames.
  136.   * Reduce executable size (not everything is fully optimised yet).
  137.  
  138.  
  139. Where can I learn more about Java?
  140.  
  141.   URLs
  142.     Javasoft:  http://www.javasoft.com/
  143.     Chockcino homepage:  http://chocky.home.ml.org/java/
  144.  
  145.   Magazines
  146.     My article in December 1997 Acorn User (that's the one with the Cover CD)
  147.     My series on Java programming in RISC User.
  148.  
  149.  Make sure you look that the FAQ which is included in the docs directory
  150.  also.
  151.  
  152.  
  153. Acknowlegdements:
  154.  
  155.   Tony Houghton - for help with the C++ templates.
  156.   Peter Burwood - again for help with C++ templates, the alternative
  157.     sprite, and for many comments and much miscelleneous help.
  158.   Jon Wright - for the Frontend. 
  159.   The UnixLib team
  160.   The #acorn channel
  161.  
  162.  
  163. Any comments, critisims, etc, to Peter Naulls - pnaulls@usa.net.
  164.  
  165.  
  166.